home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / pcbfre2e.zip / PCBFRE.DOC < prev    next >
Text File  |  1992-01-23  |  18KB  |  435 lines
  1.                      
  2.  
  3.  
  4.                                    PCBFRE
  5.  
  6.                     PCBoard Dynamic File Ratio Enforcer
  7.  
  8.  
  9.                      A PCBoard Post/Call Ratio Enforcer
  10.                         Post/Download Ratio Enforcer
  11.                             Files Ratio Enforcer
  12.                             Bytes Ratio Enforcer
  13.  
  14.  
  15.                        Version 2.0, Sometime in 1992
  16.  
  17.                                 PCBFRE2?.ZIP
  18.  
  19.                     For use with PCBoard Versions 14.5x
  20.  
  21.  
  22.  
  23.                       Copyright 1991, 1992 Geoffrey Sy
  24.                             ALL RIGHTS RESERVED
  25.  
  26.  
  27.  
  28.         See !PCBFRE.NEW for a listing of changes since version 1.0.
  29.  
  30.  
  31.  
  32.                        This program is supported by:
  33.  
  34.  
  35.                                 Geoffrey Sy
  36.                                51 Wyatt Walk
  37.                           Toronto, Ontario  Canada
  38.                                   M5A 3T3
  39.  
  40.                                 Support BBS:
  41.  
  42.                            The GRAFIX Connection
  43.                              HST: (416) 287-9002
  44.                             2400: (416) 286-8734
  45.  
  46.                      
  47.  
  48.                                    - 2 -
  49.  
  50.  
  51.                             TABLE OF CONTENTS 
  52.                             =================
  53.  
  54.  
  55. Introduction ........................................................ 3
  56.  
  57. Installation ........................................................ 3     
  58.      Editing PCBoard's PWRD ......................................... 3     
  59.      Editing PCBFRE's Configuration/Program Manager ................. 3     
  60.      Editing PCBoard's Door Security File ........................... 3     
  61.      Editing PCBFRE Door Script file ................................ 4     
  62.      Trial Run ...................................................... 4     
  63.      Editing PCBFRE's Display Files ................................. 5
  64.      PCBFRE Display Files Substitution Variables .................... 5
  65.  
  66.  
  67. Program Capabilities ................................................ 6
  68.      Security/Language specific display files ....................... 6     
  69.      Non-Standard COM Ports ......................................... 6     
  70.      Session Logging ................................................ 6     
  71.      Multi-Tasking/Node Support ..................................... 6     
  72.      Network, File Sharing Support .................................. 6     
  73.      SysOp Function Keys ............................................ 7
  74.  
  75. Error Codes ......................................................... 8
  76.      Problem Report Procedure ....................................... 8
  77.  
  78. Support/Registrations................................................ 9
  79.  
  80. Disclaimers/Copyrights .............................................. 9
  81.  
  82.  
  83.                                    - 3 -
  84.  
  85.  
  86.                                INTRODUCTION
  87.                                ============
  88.  
  89. This program was written because of SysOps complaints of PCBoard's lack of
  90. ratio enforcement.  PCBFRE is a utility door for PCBoard 14.5x to calculate
  91. user download bytes based on their download/upload and post/call ratio.
  92.  
  93.  
  94.                       PROGRAM INSTALLATION/OPERATION
  95.                       ==============================
  96.  
  97. Step #1:
  98. =======
  99.  
  100. Edit PCBoard's PWRD file and set daily download bytes to 0 for the security
  101. levels affected by this program.
  102.  
  103. Step #2:
  104. ========
  105.  
  106. Edit PCBFRE's configuration file.  The one included in this archive is called
  107. PCBFRE.CNF.  Please use FRESM to edit this file.  The command line for
  108. starting FRESM is: FRESM  PCBFRE.CNF  C:\PCB
  109.                                 │        │
  110.                                 │       PCBoard System directory
  111.                           Name of CNF file
  112.  
  113. There are 2 options on the main menu:
  114.  
  115.                    A - Edit Configuration File
  116.                    B - Edit PCBFRE Security Table
  117.                    C - Edit Banking Data File
  118.  
  119.      Option A edits PCBFRE's configuration file.  Some of the options
  120.      include BBS Name, Registration number, Display screens.
  121.  
  122.      Option B edits PCBFRE's Security levels table.  This is where the ratio
  123.      options for the security levels are controlled.
  124.  
  125.      Option C edits PCBFRE's banking data file.  Use this function to modify
  126.      information in the banking data file.
  127.  
  128.                                    -4-
  129.  
  130.  
  131. Step #3:
  132. ========
  133.  
  134. Setup PCBFRE as a PCBoard Door.  Load up PCBSetup, go to edit door security
  135. file and add the following line:
  136.  
  137.                                   USER DOOR
  138.  Filename    Password   Sec Login SYS  SYS  Shell Path to DOOR Files
  139. ══════════ ════════════ ═══ ═════ ════ ════ ═════ ═══════════════════     
  140. PCBFRE                   0   Y    Y    N     Y
  141.  
  142. The Autologin and Shell options are optional.  PCBFRE requires about 128K to
  143. operate.  Make sure you have enough memory if you want PCBoard to shell to
  144. PCBFRE.  The USERS.SYS option must be set to Y or PCBFRE won't work!  You may
  145. now edit the PCBFRE door script.  Call up the text editor and create a file
  146. with the following item (this file is included in this package):
  147.  
  148.      @ECHO OFF
  149.      REM PCBoard door script for PCBFRE - PCBoard File Ratio Enforcer.      
  150.      %PCBDRIVE%
  151.      CD \PCB\FRE
  152.      PCBFRE PCBFRE.CNF C:\PCB  /POSTDL /NEW:204800:1
  153.      CD %PCBDIR%
  154.      IF (%INPCB%)==(Y) EXIT
  155.      BOARD
  156.  
  157. The above is your typical door script file.  The command line for PCBFRE is
  158. explained below:
  159.  
  160.      PCBFRE PCBFRE.CNF C:\PCB  /POSTDL /NEW:204800:1
  161.               │          │        │       │
  162.               │          │        │     Award new user with starting bytes
  163.               │          │      Enforce post/download instead of post/call
  164.               │        Location of your PCBoard Node directory
  165.          PCBFRE's configuration
  166.  
  167. Some of the available command line options are:
  168.  
  169.      /BANK   - This tells PCBFRE to bypass the enforcer functions and run
  170.                the banking functions.
  171.  
  172.      /POSTDL - This tells PCBFRE to enforce "Messages Post/Files Download"
  173.                Ratio instead of the normal Messages Post/Calls Ratio.
  174.  
  175.      /NEW:204800:1 - This tells PCBFRE to give new users some upload
  176.            │     │   credits.
  177.            │     │
  178.            │    The number of uploaded files to give new users
  179.           The number of uploaded bytes to give new users
  180.  
  181.      New users affected by the /NEW:bytes:files option must meet the
  182.      following criteria:
  183.  
  184.             Files Uploaded and Downloaded = 0
  185.             Bytes Uploaded and Downloaded = 0
  186.             User's security level must exist in PCBFRE's ratio table
  187.  
  188. That's all that's needed.  The line "IF (%INPCB%)==(Y) EXIT" is used to exit
  189. from shelled doors.  If you don't run PCBFRE as a shelled door then you may
  190. remove it.
  191.  
  192.  
  193. Step #4:
  194. ========
  195.  
  196. TRIAL RUN.  If you have a runtime error please check the runtime error codes
  197. in this document.                   -5-
  198.  
  199. Step #5:
  200. ========
  201.  
  202. Cosmetics:  The external display files called 'PCBFRE', 'FILES', 'MSGS' and
  203. other may be edited to your taste. Press F2 to edit the non-colored version
  204. and F3 to edit the ANSI version from FRESM.  Feel free to customize these
  205. files to match the theme of your BBS.   All ASCII, ANSI and IBM graphics
  206. characters are supported in the display files.  You can use all PCBoard's
  207. @X## colour codes as well as the following variables:
  208.  
  209.      @MSGRATIO@           SysOp set # of calls allowed per message posted
  210.      @FILERATIO@          SysOp set # of files download per file uploaded
  211.      @BYTERATIO@          SysOp set # of bytes download per byte uploaded
  212.      @ADJBYTES@           Adjusted download bytes available
  213.      @MSGLEFT@            Messages user has left/uploaded to PCBoard
  214.      @MSGREAD@            Message user has read/downloaded from PCBoard
  215.  
  216.      $B$                  modem open baud rate
  217.      $C$                  connect bps same as @BPS@
  218.      $CLREOL$             clear to end of line
  219.      $DEFAULT$            the default color
  220.      $FIRST$              callers first name
  221.      $N$                  port number 0=local, 1..4
  222.      $NAME$               callers full name same as @USER@
  223.      $NODE$               current node number
  224.      $NONSTOP$            display the rest of the file non-stop
  225.      $SYSOP$              sysop name
  226.      $TIME$               daily time limit in minutes
  227.      @BEEP@               beep speaker, control-g
  228.      @BOARDNAME@          the name of your BBS
  229.      @BPS@                estimated connect bps
  230.      @CITY@               city and state of caller (all caps)
  231.      @CLS@                clear screen
  232.      @DATAPHONE@          caller's business/data phone number
  233.      @DLBYTES@            total bytes downloaded - all calls
  234.      @DLFILES@            total files downloaded - all calls
  235.      @EVENT@              time of next scheduled event
  236.      @EXPDATE@            subscription expiration date
  237.      @FIRST@              first name of the user (first letter capitalized)
  238.      @HOMEPHONE@          caller voice phone number
  239.      @LASTDATEON@         last date on (mm-dd-yy format)
  240.      @LASTTIMEON@         last time on (hh:mm format)
  241.      @MORE@               force a "MORE" prompt
  242.      @NUMTIMESON@         number of times on system
  243.      @SECURITY@           users current security level including conf. add.
  244.      @SYSDATE@            host date in (mm-dd-yy format)
  245.      @SYSTIME@            host system in (hh:mm format)
  246.      @TIMELEFT@           time remaining that call incl. all credits, etc.
  247.      @TIMELIMIT@          time allowed from PWRD file
  248.      @TIMEUSED@           minutes used since logon
  249.      @UPBYTES@            total bytes uploaded - all calls
  250.      @UPFILES@            total files uploaded - all calls
  251.      @USER@               complete name of the caller (first & last in caps)
  252.      @WAIT@               force a "press enter to continue" prompt -6-
  253.  
  254.  
  255.                             PROGRAM CAPABILITIES
  256.                             ====================
  257.  
  258. PCBFRE is a standard ProKit door.  Some of its features include:
  259.  
  260.      +    Security-level / Language specfic display files:
  261.  
  262.           To activate this feature, replace the first 3 letters of the menu
  263.           name with the security level.
  264.  
  265.                     For level 60,  NORMAL becomes 060MAL
  266.  
  267.           For language specfic menu, let say French just add the extension  
  268.           as specified in PCBoard.
  269.  
  270.                 For French (.FRE), NORMAL becomes NORMAL.FRE
  271.                 Add level specfic and it becomes  060MAL.FRE
  272.  
  273.      +    Support for non-standard COM ports COM3 - COM8.  If the door      
  274.           doesn't work with your COM port you may set the following
  275.           environment variables:
  276.  
  277.                               SET COMBASE=nnnn
  278.           Sets the base I/O address (in DECIMAL) for non-standard COM       
  279.           ports.
  280.  
  281.                                 SET COMIRQ=n
  282.           Sets the IRQ level for non-standard COM ports.
  283.  
  284.      +    Multi-Nodes are Supported
  285.  
  286.      +    Baud Rates up to 115200 bps are suppored
  287.  
  288.      +    Complete session logging. Everything the user sees can be
  289.           captured in a session log.  This is enabled by adding
  290.                      SET PRODEBUG=ON
  291.           to the door script;  output will be logged to DEBUG.OUT.
  292.  
  293.      +    Operation under DoubleDOS, TaskView or DesqView is fully
  294.           supported. The door will give up idle time to speed the other     
  295.           partition. If screen bleedthrough or background lockups occur,    
  296.           you may need to add the environment statement
  297.                      SET OVCRT=ON
  298.           before executing the door.  This disables direct screen write.
  299.  
  300.      +    Automatic network file sharing is implemented on all system       
  301.           files. The door has been tested under LanTastic, Novell, NTNX and 
  302.           other true networks.      -7-
  303.  
  304.  
  305.      +    Sysop function keys are supported:
  306.               F2  . . . Lockout current user
  307.               F3  . . . Toggle printer logging
  308.               F4  . . . Toggle operator page bell
  309.               F5  . . . Shell to DOS while caller is online
  310.               F7  . . . Toggle alarm beeps
  311.               F8  . . . Force immediate logoff and hangup
  312.               F9  . . . Toggle local display
  313.               F10 . . . Chat with user
  314.               ALT-B . . Debug/display memory and overlay information        
  315.               ALT-I . . File input during message entry and CHAT
  316.               ALT-F . . File capture of all displays
  317.               ALT-M . . Node status display
  318.               ALT-N . . Sysop on-next
  319.               ALT-P . . Print complete session
  320.               ALT-X . . Sysop dos-exit next
  321.               UP  . . .   Increase online time
  322.               DOWN  . . Decrease online time
  323.               PgUp  . . Display comments from user file
  324.               PgDn  . . Display phone numbers, expiration and password      
  325.               HOME  . . Sysop help message, listing available functions     
  326.               SHIFT . . F1..F10 . Sysop macro keys defined in PCBSETUP
  327.  
  328.  
  329.  
  330.                                 ERROR CODES
  331.                                 ===========
  332.  
  333.      Error    Class     Description
  334.  
  335.         2     DOS:       File not found  (Check command line)
  336.         3     DOS:       Path not found
  337.         4     DOS:       Too many open files (Check CONFIG.SYS)
  338.         5     DOS:       File access denied
  339.         6     DOS:       Bad file handle
  340.        12     DOS:       Bad file access code
  341.        16     DOS:       Can't remove current dir
  342.        15     DOS:       Bad drive number
  343.       100     I/O:       Disk read error
  344.       101     I/O:       Disk write error
  345.       102     I/O:       File not assigned
  346.       103     I/O:       File not open
  347.       104     I/O:       File not open for input
  348.       105     I/O:       File not open for output
  349.       106     I/O:       Bad numeric format (Check numbers in .CNF)
  350.       150     CRITICAL:  Disk is write-protected
  351.       151     CRITICAL:  Unknown unit
  352.       152     CRITICAL:  Drive not ready
  353.       153     CRITICAL:  Unknown command
  354.       154     CRITICAL:  CRC error in data
  355.       156     CRITICAL:  Disk seek error -8-
  356.  
  357.       157     CRITICAL:  Unknown media type
  358.       158     CRITICAL:  Sector not found
  359.       159     CRITICAL:  Printer out of paper
  360.       160     CRITICAL:  Device write fault
  361.       161     CRITICAL:  Device read fault
  362.       162     CRITICAL:  Network or Hardware failure
  363.       200     FATAL:     Division by zero
  364.       201     FATAL:     Range check
  365.       202     FATAL:     Stack overflow
  366.       203     FATAL:     Heap overflow
  367.       204     FATAL:     Bad pointer operation
  368.       205     FATAL:     Floating point overflow
  369.       206     FATAL:     Floating point underflow
  370.       207     FATAL:     Bad floating point operation
  371.       208     FATAL:     Overlay Manager not initialized
  372.  
  373.  
  374.  
  375.                               PROBLEM REPORTS
  376.                               ===============
  377.  
  378. If you need to report a problem, please capture the session using DOS
  379. environment variable "SET PRODEBUG=ON".  The ouput file called "DEBUG.OUT"
  380. will be in the same directory that PCBFRE is executed from.  Depending on the
  381. node, the file will be named "DEBUG#.OUT" where # is the node number.  Please
  382. include this file as well as the USERS.SYS file in use during that session
  383. and a thorough explanation of the problem encountered. Please ZIP these files
  384. up and send it to my support BBS.   -9-
  385.  
  386.  
  387.                                   SUPPORT
  388.                                   =======
  389.  
  390. If you have any questions, bugs, or suggestions, please contact me.  I may be
  391. reached on the NaNET IBM, ProDOOR echo, Intelec(tm), City2City(tm), Rime, and
  392. other PCBoard echoes.  Or by mail to the above address.  Registered users may
  393. contact me using the voice number in the registration document.
  394.  
  395. Since this is user supported software, I don't expect you to register if you
  396. don't like it or if it doesn't meet your needs.  Just stop using it after a
  397. reasonable trial period (2-3 weeks). The program is not crippled in any way,
  398. there is only a short delay at the start/exit of the program to remind the
  399. user that the copy is un-registered.  I've had to do this because I've seen
  400. users use my program and never bothered to echo me a comment on the program.
  401. I like to get feedbacks, doesn't matter if they're good or bad. If you like
  402. the program and use it regularly, please register it.  Registration only
  403. costs $15.00 and you'll receive unlimited voice support and upgrades. Please
  404. mail your registration to the above address.
  405.  
  406. When you register, I will personally upload a registered copy and your
  407. registration information to your BBS.  The registration information will
  408. register all future versions of PCBFRE for you.  If you are not in the local
  409. 416 calling area then please add the appropriate amount to cover mailing and
  410. disk or long distance charges.  If you don't want the disk or me to upload
  411. the program, then don't add anything - your registration number will be sent
  412. by first class mail. Future copies downloaded from bulletins boards will work
  413. as registered copies when branded with your registration number.
  414.  
  415. If you plan to drop by my home to pick up the registration, please let me
  416. know in advance. I live in a rough neighborhood, so watch yourself if you
  417. really must pick up the registration in person. A few has dropped by so far
  418. and and have escaped safely with their registration.
  419.  
  420.  
  421.  
  422.                       STANDARD DISCLAIMERS/COPYRIGHTS
  423.                       ===============================
  424.  
  425. This program is provided on an "AS IS" basis.  No warranty of any kind is
  426. expressed or implied.  YOU USE THIS PROGRAM AT YOUR OWN RISK.  I take no
  427. responsibility for any damage caused directly or indirectly from the use or
  428. the inability to use this program.
  429.  
  430.  
  431. ProKit & Pro* Utilities - Copyrighted: Samuel H. Smith - The Tool Shop
  432. PCBoard                 - Copyrighted: Clarke Development Company
  433. Other                   - Copyrighted: Respected Owners
  434.  
  435.